﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System.Collections.Generic;
using System.Xml.Serialization;

#endregion

namespace ScrumTable.Common.Config.Xml
{
    /// <summary>
    /// Represents the root configuration node interface.
    /// </summary>
    public interface IXmlConfigSection
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the name of the current configuration section.
        /// </summary>
        [XmlIgnore]
        string SectionName { get; }

        /// <summary>
        /// Gets the child configuration sections for the current instance.
        /// </summary>
        /// <remarks>
        /// The current list is READ ONLY.
        /// </remarks>
        [XmlIgnore]
        IDictionary<string, ICollection<IXmlConfigSection>> Sections { get; }

        /// <summary>
        /// Gets the configuration properties of the current section.
        /// Caution:
        /// The property named "Name" is an identifier and will
        /// not be listed in the Properties dictionary!
        /// </summary>
        /// <remarks>
        /// The current list is READ ONLY.
        /// </remarks>
        [XmlIgnore]
        IDictionary<string, IXmlConfigProperty> Properties { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        #endregion

        #region Events
        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}
